feat: atomic object update #570

alexgao001 · 2024-01-24T07:35:31Z

Description

Enable atomic object update.

Introduces a new Msg MsgUpdateObjectContent, added fields to current ObjectInfo model.

message ObjectInfo {
  ..... 
  // is_updating indicates whether a object is being updated.
  bool is_updating = 16;
  // updated_at define the block timestamp when the object is updated. Will not be visible until object is re-sealed.
  int64 updated_at = 17;
  // updated_by defined the account address of updater(if there is). Will not be visible until object is re-sealed.
  string updated_by = 18 [(cosmos_proto.scalar) = "cosmos.AddressString"];
  // version define the version of object
  int64 version = 19;
}

Modify current seal object process so that a object under updating can be sealed.
Lock Updated Object while user submit the request.
Once object is updated successfully, new bill is base on the updated object, previous payment will be deducted.

More details please refer to bnb-chain/BEPs#346

Rationale

tell us why we need these changes...

Example

add an example CLI or API response...

Changes

Notable changes:

add each change in a bullet point here
...

Potential Impacts

add potential impacts for other components here
...

proto/greenfield/storage/events.proto

proto/greenfield/storage/types.proto

x/storage/keeper/keeper.go

forcodedancing · 2024-02-20T08:38:25Z

x/storage/keeper/keeper.go

+			return err
+		}
+	}
+	_ = k.MustGetPrimarySPForBucket(ctx, bucketInfo)


This line _ = k.MustGetPrimarySPForBucket(ctx, bucketInfo) is not needed.

forcodedancing · 2024-02-20T08:44:46Z

x/storage/types/keys.go

@@ -101,6 +112,12 @@ func GetObjectByIDKey(objectId math.Uint) []byte {
 	return append(ObjectByIDPrefix, seq.EncodeSequence(objectId)...)
 }

+// GetShadowObjectByIDKey return the shadowObjectId store key
+func GetShadowObjectByIDKey(objectId math.Uint) []byte {


We don't need bucketName + objectName -> id -> shadow object.
We can just bucketName + objectName -> shadow object, to save storage and make code easier.

Yep, change is applied.

forcodedancing · 2024-02-20T08:51:48Z

x/storage/keeper/keeper.go

+			return err
+		}
+	} else {
+		objectInfo.IsUpdating = true


IsUpdating is a temp field. It seems better we just put into ShadowObjectInfo - so it will be deleted with shadow object to save storage.

forcodedancing · 2024-02-20T08:56:24Z

x/storage/keeper/keeper.go

+	}
+
+	bbz := k.cdc.MustMarshal(bucketInfo)
+	store.Set(types.GetBucketByIDKey(bucketInfo.Id), bbz)


Do we change bucketInfo here?

no change made, removed.

forcodedancing · 2024-02-20T08:57:58Z

x/storage/keeper/keeper.go

+		return errors.Wrapf(types.ErrAccessDenied, "Only allowed owner/updater to do cancel update object")
+	}
+
+	objectInfo.IsUpdating = false


Put IsUpdating into shadowObject will reduce such codes.

alexgao001 added the wip label Jan 24, 2024

alexgao001 force-pushed the feat-atomic-file-update branch 2 times, most recently from 56e56a4 to c6860c2 Compare January 24, 2024 12:24

alexgao001 force-pushed the feat-atomic-file-update branch 2 times, most recently from f956aac to bc85d0f Compare February 2, 2024 07:28

alexgao001 added r4r and removed wip labels Feb 2, 2024